Reviewer's Guide

Adds a platform check to skip using the permission_handler microphone permission request on macOS, relying instead on the record package’s own permission handling, and declares the required microphone usage description in the macOS Info.plist.

Sequence diagram for updated microphone permission handling

sequenceDiagram
    actor User
    participant ChannelParametersWidget
    participant PermissionHandler
    participant RecordPlugin
    participant MacOSSystem
    participant OtherOSSystem

    User->>ChannelParametersWidget: Tap inBuiltMIC option
    activate ChannelParametersWidget
    ChannelParametersWidget->>ChannelParametersWidget: onChangedMicSelection(value)
    alt Platform isMacOS
        ChannelParametersWidget-->>PermissionHandler: Skip microphone.request()
        ChannelParametersWidget->>RecordPlugin: StartRecording()
        RecordPlugin->>MacOSSystem: RequestMicrophoneAccess
        MacOSSystem-->>RecordPlugin: GrantOrDeny
        RecordPlugin-->>ChannelParametersWidget: RecordingStatus
    else Platform is not MacOS
        ChannelParametersWidget->>PermissionHandler: Permission.microphone.request()
        PermissionHandler-->>OtherOSSystem: RequestMicrophoneAccess
        OtherOSSystem-->>PermissionHandler: GrantOrDeny
        PermissionHandler-->>ChannelParametersWidget: PermissionStatus
        ChannelParametersWidget->>RecordPlugin: StartRecording()
        RecordPlugin-->>ChannelParametersWidget: RecordingStatus
    end
    deactivate ChannelParametersWidget

Class diagram for ChannelParametersWidget microphone permission change

classDiagram
    class ChannelParametersWidget {
    }

    class _ChannelParametersState {
        +bool isInBuiltMICSelected
        +void onChangedInBuiltMic(bool value)
    }

    ChannelParametersWidget --> _ChannelParametersState : creates

    class Platform {
        +static bool isMacOS
    }

    class Permission {
        +static Permission microphone
        +Future request()
    }

    class RecordPlugin {
        +Future startRecording()
    }

    _ChannelParametersState ..> Platform : checks_platform
    _ChannelParametersState ..> Permission : requests_mic_permission_non_macos
    _ChannelParametersState ..> RecordPlugin : starts_recording

    note for _ChannelParametersState "onChangedInBuiltMic(value) {
  if (!Platform.isMacOS) {
    await Permission.microphone.request()
  }
  setState(updateMicSelection)
}"

File-Level Changes

Assessment against linked issues

Possibly linked issues

• In-built Mic on MacOS doesn't work in oscilloscope #3181: The PR conditionally skips permission_handler on MacOS and adds NSMicrophoneUsageDescription, resolving the MacOS mic crash.

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.